docs: align NUT config docs with runtime behavior - #50
Open
patrix87 wants to merge 2 commits into
Open
Conversation
There was a problem hiding this comment.
Pull request overview
Updates NUT configuration documentation to match the current runtime configuration model (single nut.ups string rather than separate ups + hostname fields).
Changes:
- Remove the obsolete
nut.hostnameentry from docs. - Document
nut.upsas<ups-name>@<hostname>and update the quickstart YAML example accordingly.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| docs/quickstart.md | Updates the minimal config example to use ups@hostname and removes nut.hostname. |
| docs/configuration.md | Updates the nut.ups format documentation and removes the hostname option from the config reference. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR aligns documentation with current implementation.
The error was introduced in this commit where hostname was removed but documentation was added mentionning it.